Pest’датый фреймворк для тестирования

О себе

Забанов Александр

• Руководитель направления Backend в комании Веб/Практик
• 9+ лет в backend
• PHP : Bitrix, Laravel, Symfony, Yii2
• NodeJS : Nest, Express

Что обсудим?

• Для чего нужны автотесты?
• Что такое Pest?
• Синтаксический сахар
• "Альтернативные" тесты
• TODOS
• Выводы

Кто пишет тесты?

Проблема % покрытия тестами

• Заблуждение, что экономия на тестах = экономии бюджета проекта
• Нет компетенций
• Лень ;)

Для чего нужны автотесты

• Обеспечение качества кода
• Экономия времени и ресурсов
• Уверенность при изменениях
• Поддержание стабильности и надежности
• Упрощение поиска ошибок
• Повышение производительности команды
• Интеграция с CI/CD пайплайном

PHPUnit

Популярный фреймворк для модульного тестирования на языке PHP

xxxxxxxxxx

class CalculatorTest extends TestCase

{

    public function testAddition()

    {

        $calc = new Calculator();

        $result = $calc->add(2, 3);

        $this->assertEquals(5, $result);

    }

}

​

Что такое Pest?

Pest

Сообщество Pest

• Активная поддержка сообщества.
• Частые обновления (даже слишком)
• Поддержка php 8.4 уже в тесте

Преимущества Pest

• Простой и лаконичный синтаксис
• Расширяемость через плагины
• Совместимость с PHPUnit
• Архитектурные тесты
• Стресс-тесты
• Мутационное тестирование
• TODOS
• Min PHP 8.2
• Если вы адепт ларавел :)

Синтаксическйи сахар

xxxxxxxxxx

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase

{

    public function test_that_true_is_true(): void

    {

        $this->assertTrue(true);

    }

}

​

x

test('true is true', function () {

    expect(true)->toBeTrue();

});

​

Скорость

Скорость

Должен жить лишь один

Миграция с PHPUnit

1. Ставим pestphp/pest-plugin-drift
   
2. Запускаем
   
3. Дрифтим
   

Миграция с PHPUnit

Работает только на 2ой версии Pest

Запуск

x

./vendor/bin/pest

x

./vendor/bin/pest  --parallel

Структура

├── 📂 tests
│   ├── 📂 Unit
│   │   └── ExampleTest.php
│   └── 📂 Feature
│   │   └── ExampleTest.phpL
│   └── TestCase.php
│   └── Pest.php
├── phpunit.xml

Файл конфигурации Pest.php

xxxxxxxxxx

error_reporting(E_ALL);

​

// pest()->extend(Tests\TestCase::class)->in('Feature');

​

pest()->project()->gitlab('webpractik/pochtabank.ru');

Плагины для редакторов кода

• Запуск из контекста IDE
• Красивая иконка у файла в IDE :)
• Шаблоны

Наименование

xxxxxxxxxx

public TestedMethod_Script_ExpectedResult()

xxxxxxxxxx

test(‘Any text’, function () {

    expect(true)->toBeTrue();

});

Группы

x

uses()->group('unit');

x

./vendor/bin/pest --group=unit

Skip

x

    it('has home', function () {

        //

    })->skip();

    //->skip('The kvadrober doesn't have a home yet');

    //->skip($condition == true, 'The kvadrober doesn't have a home yet');

    //->skipOnWindows(); // or skipOnMac() or skipOnLinux() ...

    //->skipOnPhp('>=8.0.0');

Хуки

x

    beforeEach(function () {

        // Подготовьте что-нибудь перед каждым тестовым запуском...

    });

    afterEach(function () {

        // Очищайте данные тестирования после каждого тестового запуска....

    });

    beforeAll(function () {

        // Подготовьте что-нибудь перед запуском любого из тестов этого файла...

    });

    afterAll(function () {

        // Очистите данные тестирования после всех проведенных тестов...

    });

Mocking

xxxxxxxxxx

use App\Repositories\AnimalFeedRepository;

use Mockery;

​

it('may buy a pet food', function () {

    $client = Mockery::mock(KvadroberClient::class);

    $client->shouldReceive('post');

​

    $books = new AnimalFeedRepository($client);

    $books->buy(); // API на самом деле не вызывается, поскольку `$client->post()` был имитирован...

});

​

Higher Order Testing

xxxxxxxxxx

expect($user)

    ->name->toBe('James')

    ->surname->toBe('Bond')

    ->addTitle('Mr.')->toBe('Mr. James Bond');

Архитектурные тесты

xxxxxxxxxx

arch()

    ->expect('App')

    ->toUseStrictTypes()

    ->not->toUse(['die', 'dd', 'dump']);

arch()

    ->expect('App\Models')

    ->toBeClasses()

    ->toOnlyBeUsedIn('App\Repositories')

    ->ignoring('App\Models\Kvadrobers');

arch()

    ->expect('App\Http')

    ->toOnlyBeUsedIn('App\Http');

• toUseStrictTypes() метод можно использовать для обеспечения того, чтобы все файлы в заданном пространстве имен использовали строгие типы.
• toBeClasses() метод можно использовать для того, чтобы гарантировать, что все файлы в заданном пространстве имен являются классами.
• toOnlyBeUsedIn() позволяет вам ограничить использование определенного класса или набора классов только определенными частями вашего приложения.
• ...

Пресеты

x

arch()->preset()->php();

arch()->preset()->security();

arch()->preset()->laravel();

Стресс-тестирование

x

composer require pestphp/pest-plugin-stressless --dev

# Запуск

./vendor/bin/pest stress Kvadrober.com

Функции стресс теста

x

// Кол-во одновременных запросов 2, длителность 5

$result = stress('Kvadrober.com')->concurrently(requests: 2)->for(5)->seconds();

// В любой момент вы можете просмотреть dd

$result = stress('Kvadrober.com')->dd();

// $result = stress('Kvadrober.com')->dump();

// $result = stress('Kvadrober.com')->verbosely();

Результаты стресс-теста

• Длительность запроса
• Количество запросов
• Оценка (кол-во запрос в секунду)
• Количество неудачных запросов
• Скорость невыполненных запросов
• и тп

Покрытие

Type Coverage

x

./vendor/bin/pest --type-coverage

# форматы

--type-coverage-json=my-report.json

Пример: pa31 означает, что отсутствует тип параметра функции в строке 31

Mutation Testing

xxxxxxxxxx

./vendor/bin/pest --mutate

# or in parallel...

./vendor/bin/pest --mutate --parallel

• В тестом файле указываем, какую часть кода охватывате тест. Например: covers(TodoController::class); // or mutates(TodoController::class
• Запускаем тесты
• Если тест все еще проходит против мутации, это означает, что тест не охватывает эту конкретную часть кода
• Pest выведет мутацию и разницу кода
• Пищем дополнительные тесты
• Профит

Snapshot

xxxxxxxxxx

it('has a contact page', function () {

   $response = $this->get('/contact');

   expect($response)->toMatchSnapshot();

});

Для динамических данных

xxxxxxxxxx

expect()->pipe('toMatchSnapshot', function (Closure $next) {

   if (is_string($this->value)) {

       $this->value = preg_replace(

           '/name="_token" value=".*"/',

           'name="_token" value="my_test"',

           $this->value

       );

   }

   return $next();

});

TODOS

xxxxxxxxxx

it('has a contact page', function () {

    //

})->todo();

​

// Просмотреть отдельно

​

./vendor/bin/pest --todos

Назначение задач

xxxxxxxxxx

it('has a contact page', function () {

   //

})->todo(assignee: 'DeadLarsen');

​

//Используем флаг --assignee

./vendor/bin/pest --todos --assignee=DeadLarsen

PR

xxxxxxxxxx

it('has a contact page', function () { 

  // 

})->todo(pr: 123);

// Флаг --pr

./vendor/bin/pest --todos --pr=123

Issue

xxxxxxxxxx

it('has a contact page', function () {

   //

})->todo(issue: 123);

// Флаг --issue

​

./vendor/bin/pest --todos --issue=123

Note

xxxxxxxxxx

it('has a contact page', function () {

   //

})->todo(note: <<<NOTE

   Given I am a user

   When I visit the contact page

   Then I should see a contact form

NOTE);

Все вместе

xxxxxxxxxx

describe('contacts', function () {

   it('has a contact page', function () {

       //

   }))->issue(123); // or ->pr(123) etc

​

   it('has a contact form', function () {

       //

   })->done(pr: 567);

})->wip(assignee: 'DeadLarsen');

Выводы

Недостатки Pest

• “Деградация” для опытных пользователей PHPUnit
• Меньшая зрелость по сравнению с PHPUnit
• Совместимость с инструментами\Ограничения в специализированных случаях
• Нет обратной миграции
• Где параметризованные тесты?

Когда стоит\не стоит ;( использовать Pest

Когда стоит\не стоит ;( использовать Pest

Наш опыт

• Не планируем останаливаться на достигнутом
• Новые проекты сразу на Pest
• Особенно если они будут на Laravel

Благодарности

• Даниилу Кочетову (Back)
• Ивану Поддубному (СТО)

 ______  __                                        __
/\__  _\/\ \                                      /\ \
\/_/\ \/\ \ \___       __          __     ___     \_\ \
   \ \ \ \ \  _ `\   /'__`\      /'__`\ /' _ `\   /'_` \
    \ \ \ \ \ \ \ \ /\  __/     /\  __/ /\ \/\ \ /\ \L\ \
     \ \_\ \ \_\ \_\\ \____\    \ \____\\ \_\ \_\\ \___,_\
      \/_/  \/_/\/_/ \/____/     \/____/ \/_/\/_/ \/__,_ /